This element enables the designer to create his own parameters that can be used to change the behavior of the user interface, when linked to existing parameters (see object links).
See common elements attributes.
| Name | Value Type | Default Value | Description | Comment | V. |
|---|---|---|---|---|---|
|
name |
Empty. |
Displayed named of the parameter. |
|
1.1 |
|
|
comment |
Empty. |
Comment about the parameter. |
|
1.1 |
|
|
unit |
Empty. |
Unit of the parameter |
|
1.1 |
|
|
type |
'real' |
Type of the declared parameter |
|
1.1 |
|
|
min |
0 |
Parameter minimum value. |
|
1.1 |
|
|
max |
0 |
Parameter maximum value. |
|
1.1 |
|
|
default |
0 |
Parameter default value. |
|
1.1 |
|
|
persistent |
false |
Sets the persistency of the parameter. |
When this property is set to 'true', the parameter will be saved when closing the user interface and the value will be restored next time the user interface is opened. |
1.3 |
|
|
enum_values |
list of strings separated by ';' |
Empty |
List of text values for an enumeration. Wnen set, this automatically sets the range from 0 to the number of values in the list minus 1. Starting with v1.6.2, the start value for the enumeration is not necessarily 0, but the min value specified with the parameter if any. |
1.4.3 |
1.4.3 |
|
value_format |
' .2' |
Custom formatting used by default to display the parameter as text. See the {text_value} field in parameter text widgets. |
1.9.1 |
No |
The following example creates a single parameter handling the gain of the plug-in:
<?xml version="1.0" encoding="utf-8" ?> <SKIN language_version="1.1"> <PARAM name="gain" default="0" max="20" min="-20" unit="dB" comment="gain of the plug-in" /> </SKIN>